Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove custom options for react query hoc #755

Merged
merged 2 commits into from
Oct 6, 2022

Conversation

kevinxh
Copy link
Collaborator

@kevinxh kevinxh commented Oct 6, 2022

Description

This PR removes the second argument options for the new withReactQuery HOC.

What does this mean?

Developers will NOT be able to configure react-query.

But why?

The team is concerned about some dangerous configurations such as retry, the default retry mechanism is naive and we don't think it's helpful in any situation. We will spend more time on this feature and will add back the ability to configure react-query in a future release.

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

Changes

  • (change1)

How to Test-Drive This PR

  • (step1)

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

@kevinxh kevinxh requested a review from a team as a code owner October 6, 2022 17:37
Copy link
Contributor

@vmarta vmarta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good to me. All of the files that call withReactQuery have been updated. And the typescript-minimal project runs as expected.

Copy link
Collaborator

@adamraya adamraya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kevinxh kevinxh merged commit 9e0f596 into develop Oct 6, 2022
@kevinxh kevinxh deleted the remove-custom-react-query-config branch October 6, 2022 17:55
kevinxh added a commit that referenced this pull request Oct 18, 2022
kevinxh added a commit that referenced this pull request Oct 18, 2022
kevinxh added a commit that referenced this pull request Oct 19, 2022
bfeister added a commit to bfeister/pwa-kit that referenced this pull request Oct 20, 2022
…/W-11935976

* 'fix/W-11935976' of github.com:bfeister/pwa-kit:
  Revert "Remove custom options for react query hoc (SalesforceCommerceCloud#755)" (SalesforceCommerceCloud#775)
  Footer copyright: remove the remaining hardcoded year (SalesforceCommerceCloud#760)
  Shopper promotions hooks (SalesforceCommerceCloud#759)
  Dynamic footer Copyright date (SalesforceCommerceCloud#741)
  [commerce-sdk-react] Add mutation hooks and refactor query hooks (SalesforceCommerceCloud#726)
adamraya added a commit that referenced this pull request Oct 27, 2022
* [commerce-sdk-react] Add mutation hooks and refactor query hooks (#726)

* add mutation hook and refactor query hook

* lint

* fix eslint

* fix ts types

* fix ts type for usequery

* fix lint

* fix test

* lint

* add mutation example

* fix typo

* DRY useAuthenticated

* fix object.keys type

* use better name

* change mutation signature

* fix types

* rename mutations

* fix typos

* fix shopper login types

* fix test

* remove unused vars

* refactor mutation types

* allow useMutation to pass thru options

* remove comment

Co-authored-by: Alex Vuong <[email protected]>

* Dynamic footer Copyright date (#741)

* Update checkout-footer.jsx

* whitespace to bump CLA check

* Add translation and alternate footer changes (force push is to remove unsigned commits from git history)

* Shopper promotions hooks (#759)

* usePromotions and usePromotionsForCampaign hooks

* Footer copyright: remove the remaining hardcoded year (#760)

* Revert "Remove custom options for react query hoc (#755)" (#775)

This reverts commit 9e0f596.

* `<ImageGallery >` uses `image.link` when DIS is not set (#786)

* Fix global context pollution coming from nock (#785)

* Fix global context pollution coming from nock

* remove nock debug env var

* npm run lint:fix

* remove IDE-inserted import

* Use default locale as target if none is specified (#788)

* Use default locale as target if none is specified

* Update CHANGELOG.md

* [commerce-sdk-react] Multisite support (#769)

* add multisite support

* add test

* update comment

* pr feedback

* add locale

* add locale props to queries

* add cookie expire

* attempt to address test issues

* attempt to resolve test issue

* fix test

* fix test again

Co-authored-by: Brian Feister <[email protected]>

* ShopperOrders hooks & mutations (#766)

* Implement useOrder and usePaymentMethodsForOrder hooks

* Add useOrder shopper hook to test

* Add usePaymentMethods hook to test

* Added valid order # to test

* Updating demo

* Completed demo of useOrder and usePaymentMethods

* Added tests

* working on tests

* Fix tests

* remove custom mode

* record mock

* mock oauths/login endpoint

* added more tests

* Updating demos

* add mock response

* add mock response

* Implement hooks in test-commerce

* Began writing tests for mutation, implemented useTaxes hook, cleaned up test-commerce demo

* Passing parameters and body to mutate function

* Mutation test, tax hook, lint

* mocked response

* added removePaymentMethodForOrder hook test

* lint

* Remove mutation tests for now

* remove mutation mocks

* lint

* remove nock for mutation

* createOrder hook in test project

Co-authored-by: Alex Vuong <[email protected]>

* ShopperCustomer hooks and mutations (#762)

* `useCustomer` hook

* `useCustomerAddress` hook

* `useCustomerOrders` hook

* Solve merge conflicts

* Refactor `useCustomer` test page

* Add `useCustomerOrders` hook to test page

* Add `useCustomerBaskets` hook

* Add `useShopperCustomerProductList` hook

* Clean up

* Add ShopperCustomer mutations to test page

* Solve merge conflicts

* Wait to add test file until completed

* Add initial `useCustomer` tests

* add useRegisteredUser HOC

* clean up

* clean up

* Add query hooks tests

* Revert "Add use registered user HOC" (#783)

* Add mutation test

* Update query key structure & Invalidate cache onSuccess mutations

* lint

* Add `useQueryClient`

* Update mock responses

* Update usecustomer-returns-data.json

* PR Feedback

* Remove failing mutation test

* update mock responses

* try fix flaky test

* restore test-utils

* Solve merge conflict

Co-authored-by: Alex Vuong <[email protected]>

* [commerce-sdk-react] Implement shopper baskets hooks (#768)

* Implement queries for shopperBasket hooks

* Added UseShopperBasket page to test-commerce-sdk-react app

* Added unit tests for ShopperBasket Queries

* Added test integrations for ShopperBasket queries

* Added test integrations for shopperbasket queries

* wip

* set cache keys

* multiple refactors

* bug fixes

* lint

* revert unnecessary changes

* remove the bad test examples

* revert temp shopper customer changes

* fix test

Co-authored-by: Jainam Tushar Sheth <[email protected]>
Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Adam Raya <[email protected]>

* ApiClient config needs to  be updated when cid is changed (#790)

* Add Support policy to all SDKs (#764)

* add Support policy to all SDKs

* Additional default options for React Query (#791)

* Explore having react-query config be on user land

* PR feedback, and simplifying the default options

* Revert to making this option applied server side only

* Fix `useServerContext` returning `isServerSide=false` when on server. (#782)

* Revert contraint on prepass JSX

* PR feedback

* Nock: clean up the list of mocks after each test (#792)

* Update `instanceUrl` on `retail-react-app-demo` preset (#799)

* Update changelog files

* Bump alpha version

* Upgrade minimatch (#793)

* remove minimatch from sdk and update version in pwa-kit-dev

* update lock files

* update lock files

* add more tests

* add comment

* lint

* revert packge-lock file changes

* update pwa-kit-dev package-lock.json

* fix lockfile again

Co-authored-by: Kevin He <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: Vincent Marta <[email protected]>
Co-authored-by: Charles Lavery <[email protected]>
Co-authored-by: Ben Chypak <[email protected]>
Co-authored-by: yunakim714 <[email protected]>
Co-authored-by: Jainam Tushar Sheth <[email protected]>
adamraya added a commit that referenced this pull request Oct 27, 2022
* Starting release process for 2.3.0

* Add guards to result sent to Einstein (#756)

* Add result guards to Einstein and PLP sendViewCategory Einstein

* Bump alpha version

* Update changelog

* 🚢 `2.3.0-alpha.2` (#800)

* [commerce-sdk-react] Add mutation hooks and refactor query hooks (#726)

* add mutation hook and refactor query hook

* lint

* fix eslint

* fix ts types

* fix ts type for usequery

* fix lint

* fix test

* lint

* add mutation example

* fix typo

* DRY useAuthenticated

* fix object.keys type

* use better name

* change mutation signature

* fix types

* rename mutations

* fix typos

* fix shopper login types

* fix test

* remove unused vars

* refactor mutation types

* allow useMutation to pass thru options

* remove comment

Co-authored-by: Alex Vuong <[email protected]>

* Dynamic footer Copyright date (#741)

* Update checkout-footer.jsx

* whitespace to bump CLA check

* Add translation and alternate footer changes (force push is to remove unsigned commits from git history)

* Shopper promotions hooks (#759)

* usePromotions and usePromotionsForCampaign hooks

* Footer copyright: remove the remaining hardcoded year (#760)

* Revert "Remove custom options for react query hoc (#755)" (#775)

This reverts commit 9e0f596.

* `<ImageGallery >` uses `image.link` when DIS is not set (#786)

* Fix global context pollution coming from nock (#785)

* Fix global context pollution coming from nock

* remove nock debug env var

* npm run lint:fix

* remove IDE-inserted import

* Use default locale as target if none is specified (#788)

* Use default locale as target if none is specified

* Update CHANGELOG.md

* [commerce-sdk-react] Multisite support (#769)

* add multisite support

* add test

* update comment

* pr feedback

* add locale

* add locale props to queries

* add cookie expire

* attempt to address test issues

* attempt to resolve test issue

* fix test

* fix test again

Co-authored-by: Brian Feister <[email protected]>

* ShopperOrders hooks & mutations (#766)

* Implement useOrder and usePaymentMethodsForOrder hooks

* Add useOrder shopper hook to test

* Add usePaymentMethods hook to test

* Added valid order # to test

* Updating demo

* Completed demo of useOrder and usePaymentMethods

* Added tests

* working on tests

* Fix tests

* remove custom mode

* record mock

* mock oauths/login endpoint

* added more tests

* Updating demos

* add mock response

* add mock response

* Implement hooks in test-commerce

* Began writing tests for mutation, implemented useTaxes hook, cleaned up test-commerce demo

* Passing parameters and body to mutate function

* Mutation test, tax hook, lint

* mocked response

* added removePaymentMethodForOrder hook test

* lint

* Remove mutation tests for now

* remove mutation mocks

* lint

* remove nock for mutation

* createOrder hook in test project

Co-authored-by: Alex Vuong <[email protected]>

* ShopperCustomer hooks and mutations (#762)

* `useCustomer` hook

* `useCustomerAddress` hook

* `useCustomerOrders` hook

* Solve merge conflicts

* Refactor `useCustomer` test page

* Add `useCustomerOrders` hook to test page

* Add `useCustomerBaskets` hook

* Add `useShopperCustomerProductList` hook

* Clean up

* Add ShopperCustomer mutations to test page

* Solve merge conflicts

* Wait to add test file until completed

* Add initial `useCustomer` tests

* add useRegisteredUser HOC

* clean up

* clean up

* Add query hooks tests

* Revert "Add use registered user HOC" (#783)

* Add mutation test

* Update query key structure & Invalidate cache onSuccess mutations

* lint

* Add `useQueryClient`

* Update mock responses

* Update usecustomer-returns-data.json

* PR Feedback

* Remove failing mutation test

* update mock responses

* try fix flaky test

* restore test-utils

* Solve merge conflict

Co-authored-by: Alex Vuong <[email protected]>

* [commerce-sdk-react] Implement shopper baskets hooks (#768)

* Implement queries for shopperBasket hooks

* Added UseShopperBasket page to test-commerce-sdk-react app

* Added unit tests for ShopperBasket Queries

* Added test integrations for ShopperBasket queries

* Added test integrations for shopperbasket queries

* wip

* set cache keys

* multiple refactors

* bug fixes

* lint

* revert unnecessary changes

* remove the bad test examples

* revert temp shopper customer changes

* fix test

Co-authored-by: Jainam Tushar Sheth <[email protected]>
Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Adam Raya <[email protected]>

* ApiClient config needs to  be updated when cid is changed (#790)

* Add Support policy to all SDKs (#764)

* add Support policy to all SDKs

* Additional default options for React Query (#791)

* Explore having react-query config be on user land

* PR feedback, and simplifying the default options

* Revert to making this option applied server side only

* Fix `useServerContext` returning `isServerSide=false` when on server. (#782)

* Revert contraint on prepass JSX

* PR feedback

* Nock: clean up the list of mocks after each test (#792)

* Update `instanceUrl` on `retail-react-app-demo` preset (#799)

* Update changelog files

* Bump alpha version

* Upgrade minimatch (#793)

* remove minimatch from sdk and update version in pwa-kit-dev

* update lock files

* update lock files

* add more tests

* add comment

* lint

* revert packge-lock file changes

* update pwa-kit-dev package-lock.json

* fix lockfile again

Co-authored-by: Kevin He <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: Vincent Marta <[email protected]>
Co-authored-by: Charles Lavery <[email protected]>
Co-authored-by: Ben Chypak <[email protected]>
Co-authored-by: yunakim714 <[email protected]>
Co-authored-by: Jainam Tushar Sheth <[email protected]>

* 🚢 Version 2.3.0 (#802)

* Version 2.3.0

* Update changelog files

* Begin development on 2.4.0

Co-authored-by: Kevin He <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: Brian Feister <[email protected]>
Co-authored-by: Alex Vuong <[email protected]>
Co-authored-by: Vincent Marta <[email protected]>
Co-authored-by: Charles Lavery <[email protected]>
Co-authored-by: Ben Chypak <[email protected]>
Co-authored-by: yunakim714 <[email protected]>
Co-authored-by: Jainam Tushar Sheth <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants